U S A G E __________________________________________________________________________ ¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯¯ INSTALLATION -------------- Just copy GuideML into C: and this guide file into whereever you store good documentations. ;^) START ------- You must start GuideML from the shell. It reads the AmigaGuide file and produces a new file for every node. The file name is a concatenation of the node name (small case, ' ' is translated to '_') and '.html' (or '.htm' in MSDOS mode respectively). All new files are saved into the current directory, if no other target directory has been supplied. Always start with main.html as the first page. HTML PAGE COMPOSURE --------------------- Every page starts with a navigation bar. This is a bar with hyperlinks to the next and previous page, and to the TOC and Index pages. They work exactly the way you know it from MultiView. Additionally you may also have a hyperlink to your homepage, if you provided its path. A bar separates each hyperlink. The default navigation bar looks like this: CONTENTS | INDEX | PREV | NEXT | HOME You have several ways to change the look of the navigation bar. You may even use images. GuideML saves a default set of images you may use freely. Below the navigation bar, you'll find the contents of the page. GuideML cares about any non-ASCII char (e.g. German Umlauts) and translates them into its HTML entity. Additionally, Internet links (http://, ftp://, mailto: and so on) and E-Mail addresses are detected, and a hyperlink will be created automatically. Below the contents is another navigation bar if requested. SHELL PARAMETERS ------------------ FILE/A This is the AmigaGuide source file. You must provide this parameter! TO/K Optional: this is the target directory. Defaults to the current directory. URL=HOMEURL/K If you want to add a 'HOME' button to the navigation bar, you must place the URL of your home page here. You may also use relative UN*X paths. Example: URL="../welcome.html" PREV/K This is the text placed in the 'PREV' button. Defaults to 'PREV'. You can also use HTML tags. Non-ASCII chars will be converted automatically. If you use IMAGES option, this will be the alternative text for the image. Examples: PREV="<b>PREV</b>" PREV="<img src=prev.gif alt=PREV>" NEXT/K This is the text placed in the 'NEXT' button. Defaults to 'NEXT'. See PREV for further information. INDEX/K This is the text placed in the 'INDEX' button. Defaults to 'INDEX'. See PREV for further information. TOC/K This is the text placed in the 'CONTENTS' button. Defaults to 'CONTENTS'. See PREV for further information. HOME/K This is the text placed in the 'HOME' button. Defaults to 'HOME'. See PREV for further information. BAR/K This text is placed between the navigation button elements. Defaults to ' | ', or an empty string when IMAGES is supplied. You can also add HTML tags or use non-ASCII chars. Examples: BAR="<b> # </b>" BAR="<img src=bar.gif>" BODY/K You may add some parameters to the <body> tag of each page, e. g. change colors or use a background image. Example: BODY="background=bgpic.gif" VER=VERBATIM/S If this argument is given, GuideML shows a list of all created files and their titles. IMG=IMAGES/S If given, GuideML uses an image navigation bar. You don't need to specify the <img> tag, because everything is done automatically. A set of fitting images will be saved. Already existing files won't be replaced, so you can also savely use your own images. FTR=FOOTER/S The navigation bar will also appear at the foot of each page. You can then easily flip the page when you've read it to the end. NL=NOLINKS/S GuideML automatically detects all Internet links (like 'http://', 'ftp://' or 'mailto:') and creates a fitting HTML link. You can disable it using this option, and gain some speed! NE=NOEMAILS/S GuideML also detects E-Mail addresses (without mailto: prefix) and converts them into a HTML link. If you pass this option, this detection will be disabled, gaining a lot of speed! Also useful if the detection algorithm should fail too often. NW=NOWARN/S Don't show warnings. MSDOS/S Generate MS-DOS suffix (.htm) instead of Unix. SOME MORE EXAMPLES -------------------- · Simply convert a guide into the current directory: GuideML myguide.guide · Convert to another directory (you have to create it before!) : GuideML myguide.guide to ram:myhtml · With a link to your homepage: Absolute: GuideML myguide.guide URL="http://www.myhome.url" Relative: GuideML myguide.guide URL="../index.html" · With navigation images (also as footer): GuideML myguide.guide IMAGES FOOTER · On a sloooow Amiga: GuideML myguide.guide NOLINKS NOEMAILS · White background color: GuideML myguide.guide BODY="bgcolor=white" · For a German AmigaGuide file (Umlauts will be converted!) : GuideML myguide.guide PREV="ZURÜCK" NEXT="VOR" INDEX="INDEX" TOC="INHALT"